home *** CD-ROM | disk | FTP | other *** search
/ System Booster / System Booster.iso / Texteditors / Origami / Sources / README.FIRST < prev    next >
Text File  |  1996-09-26  |  6KB  |  146 lines
  1. This file is for first time origami users !
  2.  
  3. Welcome to the amiga version of origami !
  4.  
  5. This file will tell you how to install the origami-editor.
  6. After installing, please read the file `readme.amiga` and the
  7. files in the `AmigaDocs`-directory.
  8.  
  9. Contents
  10. --------
  11. 1. What is origami ?
  12. 2. What do you need to run origami ?
  13. 3. What is included in the package ?
  14. 4. How do I install origami ?
  15. 5. Which docs shoud I read ?
  16. 6. Copyright, Disclaimer, Acknowlegdements, Mail address
  17.  
  18. 1. What is origami ?
  19. --------------------
  20. Origami is a folding editor.
  21.  
  22. Folds are used to hide text, so you will find your point of interest
  23. faster and have a clearer structure. The fold information will be
  24. written in the textfile, but you can compile all textfiles without
  25. deleting the fold information.
  26.  
  27. Origami has all important features needed by users. This includes :
  28.  * freely configurable keyboard tables
  29.  * powerfull macro language (OCL)
  30.  * AREXX port (beta version)
  31.  * powerfull standard macros like fill-paragraph,
  32.    regular-expression-search, towers-of-hanoi and many others
  33.  
  34. For more information read the file doc/intro.
  35.  
  36. 2. What do you need to run origami ?
  37. ------------------------------------
  38. First you need the executable called origami.
  39.  
  40. Origami needs to read two files :
  41. .origamimsg : This file contains all the messages origami will print.
  42. .origamirc : This file contains all the macro definitions and the
  43.              keyboard definition. It also contains the arexx definition
  44.              and the help pages.
  45. Origami needs both files to run. If they are not found, origami will
  46. exit. The namebase (standard .origami) can be changed by using the
  47. -k option.
  48.  
  49. The files are search in the S: directory and all directories specified
  50. in the ORIPATH environment variable. You can also use the -R option to
  51. specify a different directory.
  52.  
  53. Please read the man/origami.1 file for more information.
  54.  
  55. 3. What is included in the package ?
  56. ------------------------------------
  57. The whole origami package contains several directories :
  58. The first list of directories is defined in the Origami_<version>.lha
  59. distribution.
  60.  AmigaDocs : this directory contains all amiga specific documents and
  61.              the bug.fixes file.
  62.  bin : this directory contains the amiga executables.
  63.  man :
  64.  doc : These directories contain the information about the origami
  65.        and the additional programs.
  66.  rexx : this directory contains some useful arexx scripts. At this
  67.         time only some test scripts are included, but if you have some
  68.         interesting scripts, I will surely include them there.
  69.  
  70. The second archive (Origami_Bind_<revision>.lha) contains the
  71. binding files.
  72.  bindings : here you can find the files, describing the keysequences
  73.             origami will listen for... (read the manual for more infos)
  74.  
  75. The third archive (Origami_Docs_<revision>.lha contains the sources of
  76. the origami folding editor :
  77.  doc :
  78.  man : These directories contain nroff and awk sources of the ascii
  79.        documents distributed in the other archive.
  80.  scripts : This directory contains some scripts useful on unix/linux
  81.            operating systems.
  82.  src : Contains the complete source and the directory with the amiga
  83.        port sources (see below).
  84.  
  85. The source directory has several subdirectories :
  86.  Amiga : here you can find the special files and Smakefiles used in the
  87.          amiga port.
  88.  autoalias, dirfold, h, keybind, origami, lib, viewrc :
  89.    These directories contain the complete unix source.
  90.  
  91. You will need the Origami_<version>.lha archive only, if you just want
  92. to run origami without changing anything.
  93.  
  94. You will need the Origami_Bind_<revision>.lha archive, too, if you
  95. want to change the existing bindings or use some of the macros in
  96. your own binding.
  97.  
  98. The third archive (Origami_Srcs_<revision>.lha) contains all the things,
  99. you need to compile origami on the amiga or any other os. So you will
  100. not need it in most cases.
  101.  
  102. 4. How do i install origami ?
  103. -----------------------------
  104. To install origami use the commodore installer with the install_origami
  105. script in the main directory.
  106.  
  107. 5. Which docs should I read ?
  108. -----------------------------
  109. There are several documtentation files in this distribution.
  110. You will not have to read every bit of information, so i will give
  111. you a short description of the files :
  112.  
  113. doc/intro : This file contains more information about folding editors
  114.             and origamis concept of storing file information.
  115. man/<executable>.man : These files contain a short description of
  116.    the commands and a detailed option list.
  117. AmigaDocs/README.AMIGA : This file contains all additional feature
  118.    provided by the amiga version.
  119. AmigaDocs/README.AREXX : This file gives a short introduction in
  120.    origamis way to use the Arexx port.
  121. AmigaDocs/bug.fixes : This file contains all (fixed and not-fixed)
  122.    bugs of the current version and additional or changed features.
  123. bindings/[*fun/]*.r : These files contain the reference card
  124.    descriptions of the functions defined in the responding marco
  125.    file (the file without the .r). Some of the macro packages do
  126.    not have any descriptions (this will be changed sometime.).
  127.  
  128. You should read the bug.fixes file everytime you get a new version.
  129. You should read the origami.man and maybe view the keybind.man files,
  130. if you use origami for the first time.
  131. You should read the AMIGA.README, if you use the Amiga version of
  132. origami the first time.
  133. You should read the manual and the keybind.man and viewrc.man files
  134. and the bindings/fun/*.r files, if you want to change the standard
  135. keybinds or if you want to develope a completly new binding.
  136.  
  137. 6. Copyright, Disclaimer, Acknowlegdements, Mail address
  138. --------------------------------------------------------
  139. Please read the AmigaDocs/README.AMIGA file for the information
  140. mentioned above (and some more info).
  141.  
  142.  
  143. I hope you`ll enjoy origami
  144.  
  145. Thomas Hadig
  146.